IMotion.SetGroupParameter method

Sets the value of a parameter for an axis group. The parameters are defined in McGroupParameter.

Namespace: IntervalZero.KINGSTAR.Base.Api

Assembly: IntervalZero.KINGSTAR.Base.Api (in IntervalZero.KINGSTAR.Base.dll) Version: 4.4.0.0

Syntax

KsCommandStatus SetGroupParameter(
       int Index,
       McGroupParameter ParameterNumber,
       double Value,
       McExecutionMode ExecutionMode
)

Function SetGroupParameter(
       Index As Integer,
       ParameterNumber As McGroupParameter,
       Value As Double,
       ExecutionMode As McExecutionMode
) As KsCommandStatus

Parameters

Index [in]

Type: int

The index of an axis group. Indexes are zero based. You can have up to 32 groups.

ParameterNumber [in]

Type: McGroupParameter

A parameter in McGroupParameter.

Value [in]

Type: double

Writes the value to the parameter you picked from McGroupParameter. For example, if you pick mcMaxVelocityACS in McGroupParameter, you need to write its value here.

ExecutionMode [in]

Type: McExecutionMode

Defines the chronological sequence of a method.

Return value

Type: KsCommandStatus

Returns the KsCommandStatus class.

Examples

N/A